home *** CD-ROM | disk | FTP | other *** search
/ Mac Format 1996 April / MacFormat CD Edition MF36 (April 1996).iso / Shareware City / Developers / Tools Plus - GUI⁄Event libs / Tools Plus 2.6.1a Evaluat'n Kit / Tools Plus 2.6.1a / User Manual / 04-Initializing Tools Plus < prev    next >
INI File  |  1995-04-01  |  4KB  |  75 lines
  1. [Display using Monaco 9]
  2.  
  3.  
  4. 4  Initialization
  5. `````````````````
  6.  
  7.  
  8.  
  9.  
  10.  
  11.   Tools Plus is initialized by the InitToolsPlus routine.  Your application should call InitToolsPlus as early as possible since InitToolsPlus creates unrelocatable blocks in memory, and calling it early will reduce memory fragmentation.  The initialization process loads the segments containing the Tools Plus libraries into memory (where they will reside for the duration of your application), and initializes Tools Plus’s variables.
  12.  
  13.  
  14.  
  15.  
  16.  
  17. ------------------------------------------------------------------------
  18.  
  19. InitToolsPlus
  20. `````````````
  21. Initialize Tools Plus.
  22.  
  23.    pascal Boolean InitToolsPlus (short MoreHandles, short MaxWindows,
  24.                  Boolean UseColorFlag);
  25.  
  26.    function InitToolsPlus(MoreHandles: INTEGER; MaxWindows: INTEGER;
  27.                  UseColorFlag: BOOLEAN): BOOLEAN;
  28.  
  29.   This function initializes variables and records that are required by Tools Plus.  It must be called once at the beginning of your program.
  30.  
  31.   MoreHandles specifies the number of additional “Handle Blocks” that are created during initialization.  THINK C, and CodeWarrior compilers don’t automatically create any handle blocks, while THINK Pascal automatically creates 11 blocks, each containing 64 handles and consuming 512 bytes per block.  The number of additional blocks created during Tools Plus initialization is specified by MoreHandles, which can have a value between 0 and 128.  In THINK Pascal, the default number of blocks is usually enough, so you will specify 0.  In THINK C and CodeWarrior compilers, a dozen blocks is usually enough.
  32.  
  33.   MaxWindows declares the maximum number of windows that may be open at any given time.  This number should be kept to a realistic minimum, since a certain amount of memory is consumed regardless if a window is actually opened or not.  Tools Plus supports from 1 to 50 windows.
  34.  
  35.   UseColorFlag specifies if Color QuickDraw should be used if it is available on the Macintosh on which your application is running.  If UseColorFlag is true and your application is running on a Macintosh SE or higher with a color or gray-scale monitor, Tools Plus will take advantage of the available colors or shades of gray.  If Color QuickDraw is not available, or if UseColorFlag is false, all drawing is done in black and white.  The two constants that can be used are UseColor and IgnoreColor.  When your application takes advantage of Color QuickDraw, it will consume slightly more memory and will run slightly slower.
  36.  
  37.   InitToolsPlus returns a value of true if initialization was successful, otherwise false is returned.
  38.  
  39.  
  40.  
  41.  
  42.  
  43. Initialization Failure
  44. ``````````````````````
  45.   InitToolsPlus will fail initialization for only two possible reasons: [1] a severe memory shortage exists, under which Tools Plus cannot allocate sufficient memory for the additional handles or for its own structures, or [2] your application is trying to run on a Macintosh with ROMs older than version 117.  Those are the old 64k ROMs found in the Macintosh 128K, Macintosh 512K, and Lisa (Macintosh XL).  This will not occur in the Macintosh 512KE (enhanced), or higher.  Tools Plus will display an appropriate alert if the wrong ROMs are used.
  46.  
  47. If initialization fails, do not attempt to use any Tools Plus routines.
  48.  
  49.  
  50.  
  51.  
  52.  
  53. Other Initialization
  54. ````````````````````
  55.   InitToolsPlus also performs other initializing tasks that your application would normally have to do:
  56.  
  57. • All events are automatically flushed (cleared) from the event queue,
  58.   such as keystrokes which may have been typed from The Finder.
  59.  
  60. • The “random number seed” is initialized to ensure that your
  61.   application does not generate an identical pseudo-random numeric
  62.   sequence each time it runs.
  63.  
  64.  
  65.  
  66.  
  67.  
  68. The Cursor
  69. ``````````
  70.   The cursor is displayed as a wrist-watch when your application is launched by The Finder, and will remain as such until it is changed by your application.  Note, however, that Tools Plus behaves as though a normal cursor is displayed in that it does not filter out clicks and typing (such as when your application sets the cursor to a wrist-watch).
  71.  
  72.   CONST                   {Should Color QuickDraw be used?        }
  73.     UseColor    =true;    {use Color QuickDraw if it is available }
  74.     IgnoreColor =false;   {don’t use Color QuickDraw              }
  75.